Skip to content

docs(policy): document dynamic value mappings - #385

Open
alkalescent wants to merge 2 commits into
mainfrom
docs/dynamic-value-mappings
Open

docs(policy): document dynamic value mappings#385
alkalescent wants to merge 2 commits into
mainfrom
docs/dynamic-value-mappings

Conversation

@alkalescent

@alkalescent alkalescent commented Aug 12, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

Summary

  • explain Dynamic Value Mapping configuration, evaluation, resolver behavior, and constraints
  • add a patient assignment example with matching outcomes
  • link the page from the Policy overview

Testing

  • vale docs/components/policy/dynamic-value-mappings.mdx docs/components/policy/index.md
  • npm run check-vendored-yaml
  • npm run build

Summary by CodeRabbit

  • Documentation
    • Added comprehensive documentation for Dynamic Value Mappings, including configuration, composition, resolver operators, evaluation behavior, constraints, and CLI usage.
    • Added Dynamic Value Mappings to the policy documentation overview and relationship diagram.
    • Clarified key-status semantics and the requirements for maintaining alphabetical key-status sorting.
  • New Features
    • Added key-status sorting as a supported policy key sorting option.

@alkalescent
alkalescent requested review from a team as code owners August 12, 2026 15:08
@coderabbitai

coderabbitai Bot commented Aug 12, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: a6f28883-3e55-4b24-8b1c-6470b5b2a98f

📥 Commits

Reviewing files that changed from the base of the PR and between de7e12b and 8da9189.

📒 Files selected for processing (3)
  • specs/policy/kasregistry/key_access_server_registry.openapi.yaml
  • specs/policy/objects.openapi.yaml
  • specs/policy/unsafe/unsafe.openapi.yaml
📝 Walkthrough

Walkthrough

The PR adds Dynamic Value Mappings documentation and links it from the Policy documentation. It also updates policy specifications with KeyStatus sorting metadata and mapping requirements.

Changes

Dynamic Value Mappings

Layer / File(s) Summary
Mapping concepts and configuration
docs/components/policy/dynamic-value-mappings.mdx		 Defines Dynamic Value Mappings, configuration, selectors, supported operators, evaluation behavior, and policy constraints.
Evaluation example and references
docs/components/policy/dynamic-value-mappings.mdx		 Adds a patient-assignment example and links to related Attribute, Subject Mapping, Entity Resolution, Action, CLI, and API documentation.
Policy documentation integration
docs/components/policy/index.md		 Adds Dynamic Value Mappings to the Policy relationship diagram and component list.

KeyStatus sorting specification

Layer / File(s) Summary
KeyStatus mapping and sorting contract
specs/policy/kasregistry/key_access_server_registry.openapi.yaml, specs/policy/objects.openapi.yaml, specs/policy/unsafe/unsafe.openapi.yaml		 Documents the required key_status mapping and adds SORT_KAS_KEYS_TYPE_KEY_STATUS as a supported key-list sorting field.

Estimated code review effort: 2 (Simple) | ~10 minutes

Mergeability Score: 🔵 Low · up to 8da91

The PR is primarily documentation, but it also updates generated OpenAPI specifications. Those files should be regenerated and verified against upstream to prevent documentation drift; the PR is otherwise mergeable with explicit owner follow-up.

Suggested reviewers: pflynn-virtru

Poem

A rabbit mapped each value with care,
Through resolvers hopping everywhere.
Key statuses sorted in rows,
Policy links now clearly show.
“Documentation blooms!” the rabbit sings,
With tidy rules and useful things.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely identifies the primary change: documenting Dynamic Value Mappings in policy documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/dynamic-value-mappings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

📄 Preview deployed to https://opentdf-docs-pr-385.surge.sh

@alkalescent
alkalescent enabled auto-merge (squash) August 13, 2026 02:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@alkalescent